<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 transitional//EN">
<html>
<head>
<title>Table Group Element (Eclipse BIRT ROM Documentation)</title>
<link rel="stylesheet" href="../style/style.css" type="text/css"/>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</head>
<body>
<p class="title">Eclipse BIRT Report Object Model (ROM)</p>
<p class="subtitle">TableGroup Element</p>
<h1>Element Overview</h1>
<div class="section-text">
Represents a group break level within a table.</div>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Display Name:</td>
<td>Table Group</td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>XML Element:</td>
<td><code>group</code></td></tr>
<tr><td>Extends:</td>
<td><a href="ListingGroup.html">ListingGroup</a></td></tr>
<tr><td>Extendable:</td>
<td>No</td></tr>
<tr><td>Abstract:</td>
<td>No</td></tr>
<tr><td>Name Space:</td>
<td>None</td></tr>
<tr><td>Name Requirement:</td>
<td>Not Supported</td></tr>
<tr><td>Allows User Properties:</td>
<td>Yes</td></tr>
<tr><td>Has Style:</td>
<td>No</td></tr>
</table>

<h3>Method Summary</h3>

<dl class="section-text">
<dt><a href="#Method-onPageBreak">onPageBreak</a></dt>
<dd></dd>
<dt><a href="#Method-onPrepare">onPrepare</a></dt>
<dd>It is for a script startup phase. No data binding yet. The design of an element can be changed here.</dd>
</dl>

<h3>Slot Summary</h3>

<dl class="section-text">
<dt><a href="#Slot-header">header</a></dt>
<dd>The header band for this group.</dd>
<dt><a href="#Slot-footer">footer</a></dt>
<dd>The footer rows for this group.</dd>
</dl>

<h3>Inherited Properties</h3>

<p class="section-text">
<a href="ListingGroup.html#Property-ACLExpression">ACLExpression</a>, 
<a href="ListingGroup.html#Property-bookmark">bookmark</a>, 
<a href="ListingGroup.html#Property-bookmarkDisplayName">bookmarkDisplayName</a>, 
<a href="ListingGroup.html#Property-cascadeACL">cascadeACL</a>, 
<a href="ListingGroup.html#Property-eventHandlerClass">eventHandlerClass</a>, 
<a href="ListingGroup.html#Property-filter">filter</a>, 
<a href="ListingGroup.html#Property-groupName">groupName</a>, 
<a href="ListingGroup.html#Property-hideDetail">hideDetail</a>, 
<a href="ListingGroup.html#Property-interval">interval</a>, 
<a href="ListingGroup.html#Property-intervalBase">intervalBase</a>, 
<a href="ListingGroup.html#Property-intervalRange">intervalRange</a>, 
<a href="ListingGroup.html#Property-keyExpr">keyExpr</a>, 
<a href="ListingGroup.html#Property-newHandlerOnEachEvent">newHandlerOnEachEvent</a>, 
<a href="ListingGroup.html#Property-pageBreakAfter">pageBreakAfter</a>, 
<a href="ListingGroup.html#Property-pageBreakBefore">pageBreakBefore</a>, 
<a href="ListingGroup.html#Property-pageBreakInside">pageBreakInside</a>, 
<a href="ListingGroup.html#Property-repeatHeader">repeatHeader</a>, 
<a href="ListingGroup.html#Property-sort">sort</a>, 
<a href="ListingGroup.html#Property-sortDirection">sortDirection</a>, 
<a href="ListingGroup.html#Property-sortType">sortType</a>, 
<a href="ListingGroup.html#Property-toc">toc</a>, 
<a href="ListingGroup.html#Property-viewAction">viewAction</a>
</p>
<h3>Inherited Methods</h3>

<p class="section-text">
<a href="ListingGroup.html#Method-onCreate">onCreate</a>, 
<a href="ListingGroup.html#Method-onRender">onRender</a></p>
<h3>Description</h3>

<div class="section-text">
<p>A table is often divided into a number of groups. Groups 
provide a way of showing common headings for a group of related rows. Groups 
often have subtotals. For example, a sales report may show totals per sales rep 
and region.</p>
<p>A group is defined by a <i>group key.</i> The key is a 
column from the query. If the group key is a time field then user often want to 
group on an <i>interval</i> such as month or quarter.</p></div>
<h1>Method Detail</h1>

<h2><a name="Method-onPageBreak">onPageBreak Method</a></h2>

<p class="section-text"></p>
<h3>Synopsis
</h3>

<p class="section-text"><code>None&nbsp;obj.onPageBreak(&nbsp;)</code></p>
<h3>Details
</h3>

<table class="detail-table">
<tr><td>Since:</td>
<td>2.1</td></tr>
<tr><td>Context:</td>
<td>presentation</td></tr>
<tr><td>Arguments:</td>
<td>None</td></tr>
<tr><td>Return Type:</td>
<td>None</td></tr>
</table>


<hr>
<h2><a name="Method-onPrepare">onPrepare Method</a></h2>

<p class="section-text">It is for a script startup phase. No data binding yet. The design of an element can be changed here.</p>
<h3>Synopsis
</h3>

<p class="section-text"><code>None&nbsp;obj.onPrepare(&nbsp;)</code></p>
<h3>Details
</h3>

<table class="detail-table">
<tr><td>Since:</td>
<td>2.0</td></tr>
<tr><td>Context:</td>
<td>startup</td></tr>
<tr><td>Arguments:</td>
<td>None</td></tr>
<tr><td>Return Type:</td>
<td>None</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>It is for a script startup phase. No data binding yet. The design of an element can be changed here.</p></div>
<h1>Slot Detail</h1>

<h2><a name="Slot-header">header Slot</a></h2>

<p class="section-text">The header band for this group.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Display Name:</td>
<td>Header</td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>XML Element:</td>
<td><code>header</code></td></tr>
<tr><td>Contents:</td>
<td>List of <a href="Row.html">Row</a></td></tr>
<tr><td>Default Style:</td>
<td><a href="../styles.html#table-group-header">table-group-header</a></td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>The header band appears before the first detail row of a 
group. This band contains any number of table rows. Rows appear sequentially; or 
can be selected conditionally.</p>

<p>Report items within the header slot have visibility to 
the entire result set. If the header contains a simple element such as a data 
item, then it will display values from the first row of the group. If the header 
contains a chart, then the chart displays rows from the entire group. If the 
header displays an aggregate, then the aggregate is computed over the entire 
group.</p></div>
<h3>See Also</h3>

<div class="section-text">
<p>Row element defined in the <i>ROM Layout Specification</i></p></div>

<hr>
<h2><a name="Slot-footer">footer Slot</a></h2>

<p class="section-text">The footer rows for this group.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Display Name:</td>
<td>Footer</td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>XML Element:</td>
<td><code>footer</code></td></tr>
<tr><td>Contents:</td>
<td>List of <a href="Row.html">Row</a></td></tr>
<tr><td>Default Style:</td>
<td><a href="../styles.html#table-group-footer">table-group-footer</a></td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>The footer band appears after the last detail row of a 
group. This band contains any number of table rows. Rows appear sequentially; or 
can be selected conditionally.</p>

<p>Report items within the footer slot have visibility to 
the entire result set. If the footer contains a simple element such as a data 
item, then it will display values from the first row of the group. If the footer 
contains a chart, then the chart displays rows from the entire group. If the 
footer displays an aggregate, then the aggregate is computed over the entire 
group.</p></div>
<h3>See Also</h3>

<div class="section-text">
<p>Row element defined in the <i>ROM Layout Specification</i></p></div>
</body>
</html>
